home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 1 / Amiga Tools.iso / egs-tools / egs_dev-disk / egsdocs / gbscrollbox.doc < prev    next >
Encoding:
Text File  |  1994-06-06  |  7.8 KB  |  304 lines
  1. TABLE OF CONTENTS
  2.  
  3. egb/gbscrollbox.library/EGB_ActivateElem
  4. egb/gbscrollbox.library/EGB_AddItemToScrollBox
  5. egb/gbscrollbox.library/EGB_AddListToScrollBox
  6. egb/gbscrollbox.library/EGB_CreateLateScrollBox
  7. egb/gbscrollbox.library/EGB_LinkStringToScroll
  8. egb/gbscrollbox.library/EGB_NextElem
  9. egb/gbscrollbox.library/EGB_PrevElem
  10. egb/gbscrollbox.library/EGB_RemItemFromScrollBox
  11. egb/gbscrollbox.library/EGB_RemListFromScrollBox
  12. egb/gbscrollbox.library/EGB_SetTopElem
  13. egb/gbscrollbox.library/EGB_UpdateScrollBox
  14. egb/gbscrollbox.library/EGB_ActivateElemegb/gbscrollbox.library/EGB_ActivateElem
  15.  
  16.    NAME
  17.     EGB_ActivateElem -- 
  18.  
  19.    SYNOPSIS
  20.     EGB_ActivateElem(win, gad, elem)
  21.                      A0   A1   A2
  22.  
  23.     void EGB_ActivateElem(EI_WindowPtr, EI_GadgetPtr, struct Node *)
  24.  
  25.    FUNCTION
  26.     Activates an item from a gadbox scrollbox gadget. Moves the
  27.     scrollbox view if necessary.
  28.  
  29.    INPUTS
  30.     win    : The window that contains the gadget; if NULL, no refresh is done
  31.     gad    : the scrollbox gadget
  32.     item   : Pointer to the item (node) to be activated
  33.  
  34.    RESULT
  35.  
  36.    SEE ALSO
  37.  
  38.  
  39. egb/gbscrollbox.library/EGB_AddItemToScrollBoxegb/gbscrollbox.library/EGB_AddItemToScrollBox
  40.  
  41.    NAME
  42.     EGB_AddItemToScrollBox -- 
  43.  
  44.    SYNOPSIS
  45.     EGB_AddItemToScrollBox(win, gad, item)
  46.                            A0   A1   A2
  47.  
  48.     void EGB_AddItemToScrollBox(EI_WindowPtr, EI_GadgetPtr, struct Node *)
  49.  
  50.    FUNCTION
  51.     Adds an item to a scroll box. Make sure that this item is not an
  52.     element of a second list, as it is inserted into the scrollbox's
  53.     list. If the sort flag is set, the item will be inserted in
  54.     alphabetical order.
  55.  
  56.    INPUTS
  57.     win    : The window, that contains the gadget; if NULL, no refresh is done
  58.     gad    : The scrollbox gadget
  59.     item   : The item to be inserted in to the scrollbox
  60.  
  61.    RESULT
  62.  
  63.    SEE ALSO
  64.  
  65.  
  66. egb/gbscrollbox.library/EGB_AddListToScrollBoxegb/gbscrollbox.library/EGB_AddListToScrollBox
  67.  
  68.    NAME
  69.     EGB_AddListToScrollBox -- 
  70.  
  71.    SYNOPSIS
  72.     EGB_AddListToScrollBox(win, gad, list)
  73.                            A0   A1   A2
  74.  
  75.     void EGB_AddListToScrollBox(EI_WindowPtr, EI_GadgetPtr, struct List *)
  76.  
  77.    FUNCTION
  78.     Adds the elements of the list to the scrollbox. The original list is
  79.     destroyed, as the elements are not cloned, but used as they are.
  80.  
  81.    INPUTS
  82.     win      : Window that contains the gadget; if NULL, no refresh is done
  83.     gad      : the scrollbox gadget
  84.     list     : The list containing the elements to be inserted into the
  85.          scrollbox.
  86.  
  87.    RESULT
  88.  
  89.    SEE ALSO
  90.  
  91.  
  92. egb/gbscrollbox.library/EGB_CreateLateScrollBoxegb/gbscrollbox.library/EGB_CreateLateScrollBox
  93.  
  94.    NAME
  95.     EGB_CreateLateScrollBox -- 
  96.  
  97.    SYNOPSIS
  98.     EGB_CreateLateScrollBox(con, minWidth, maxWidth, minHeight, maxHeight, sort, id)
  99.                             A0   D0        D1        D2         D3         D4    D5
  100.  
  101.     EB_GadBoxPtr EGB_CreateLateScrollBox(EB_GadContext, WORD, WORD, WORD, WORD, ULONG, LONG)
  102.  
  103.    FUNCTION
  104.     Creates a gadbox scrollbox gadget. These gadgets offer a list of
  105.     Textlines, in which the user can scroll using a propgadget. One item
  106.     can be selected at any time. This item is highlighted. The size
  107.     information gives only minimum and maximum values in characters and
  108.     lines. The number of displayed lines and collumns in the gadget
  109.     depents on the surrounding gadboxes.
  110.  
  111.    INPUTS
  112.     con       : The associated gadget context
  113.     minWidth  : the minimal requiered number of collumns
  114.     maxWidth  : the maximal allowed number of collumns
  115.     minHeight : the minimal requiered number of lines
  116.     maxHeight : the maximal allowed number of lines
  117.     sort      : boolean value, if true, the scrollbox elements are sorted
  118.           by their priority and string.
  119.  
  120.    RESULT
  121.  
  122.    SEE ALSO
  123.  
  124.  
  125. egb/gbscrollbox.library/EGB_LinkStringToScrollegb/gbscrollbox.library/EGB_LinkStringToScroll
  126.  
  127.    NAME
  128.     EGB_LinkStringToScroll -- 
  129.  
  130.    SYNOPSIS
  131.     EGB_LinkStringToScroll(scroll, string)
  132.                            A0      A1
  133.  
  134.     void EGB_LinkStringToScroll(EI_GadgetPtr, EI_StringGadPtr)
  135.  
  136.    FUNCTION
  137.     Links a string gadget to a scroll box. If an item from the scrollbox
  138.     is activated, the associated string will be copied to the string
  139.     gadget. The area of the scroll gadget will follow the value in the
  140.     string gadget, when ever that is modified
  141.  
  142.    INPUTS
  143.     scroll      : a scrollbox gadget
  144.     string      : a string gadget
  145.  
  146.    RESULT
  147.  
  148.    SEE ALSO
  149.  
  150.  
  151. egb/gbscrollbox.library/EGB_NextElem     egb/gbscrollbox.library/EGB_NextElem
  152.  
  153.    NAME
  154.     EGB_NextElem -- 
  155.  
  156.    SYNOPSIS
  157.     EGB_NextElem(win, gad)
  158.                  A0   A1
  159.  
  160.     void EGB_NextElem(EI_WindowPtr, EI_GadgetPtr)
  161.  
  162.    FUNCTION
  163.     Activates the next element of a scrollbox gadget. If none is
  164.     selected the first entry will become the selected one.
  165.  
  166.    INPUTS
  167.     win    : The window that contains the gadget, if NULL, no refresh is done
  168.     gad    : The scrollbox gadget
  169.  
  170.    RESULT
  171.  
  172.    SEE ALSO
  173.  
  174.  
  175. egb/gbscrollbox.library/EGB_PrevElem     egb/gbscrollbox.library/EGB_PrevElem
  176.  
  177.    NAME
  178.     EGB_PrevElem -- 
  179.  
  180.    SYNOPSIS
  181.     EGB_PrevElem(win, gad)
  182.                  A0   A1
  183.  
  184.     void EGB_PrevElem(EI_WindowPtr, EI_GadgetPtr)
  185.  
  186.    FUNCTION
  187.     Activates the previous element in a scrollbox gadget. If none is
  188.     selected, the last one will become the selected one.
  189.  
  190.    INPUTS
  191.     win    : The window that contains the gadget; if NULL, no refresh is done
  192.     gad    : The scrollbox gadget
  193.  
  194.    RESULT
  195.  
  196.    SEE ALSO
  197.  
  198.  
  199. egb/gbscrollbox.library/EGB_RemItemFromScrollBoxegb/gbscrollbox.library/EGB_RemItemFromScrollBox
  200.  
  201.    NAME
  202.     EGB_RemItemFromScrollBox -- 
  203.  
  204.    SYNOPSIS
  205.     EGB_RemItemFromScrollBox(win, gad, item)
  206.                              A0   A1   A2
  207.  
  208.     void EGB_RemItemFromScrollBox(EI_WindowPtr, EI_GadgetPtr, struct Node *)
  209.  
  210.    FUNCTION
  211.     Removes an item from a scrollbox.
  212.  
  213.    INPUTS
  214.     win    : The window, that contains the gadget; if NULL, no refresh is done
  215.     gad    : The scrollbox gadget
  216.     item   : The element to remove, must be in the scrollbox
  217.  
  218.    RESULT
  219.  
  220.    SEE ALSO
  221.  
  222.  
  223. egb/gbscrollbox.library/EGB_RemListFromScrollBoxegb/gbscrollbox.library/EGB_RemListFromScrollBox
  224.  
  225.    NAME
  226.     EGB_RemListFromScrollBox -- 
  227.  
  228.    SYNOPSIS
  229.     EGB_RemListFromScrollBox(win, gad, list)
  230.                              A0   A1   A2
  231.  
  232.     void EGB_RemListFromScrollBox(EI_WindowPtr, EI_GadgetPtr, struct List *)
  233.  
  234.    FUNCTION
  235.     Removes all items from a scrollbox and puts them into the list. This
  236.     list may later be added to the scrollbox again.
  237.  
  238.    INPUTS
  239.     win     : The window that contains the gadget; if NULL, no refresh is done
  240.     gad     : The scrollbox gadget
  241.     list    : an empty list
  242.  
  243.    RESULT
  244.     list    : A list, that contains all items that were in the scrollbox before.
  245.  
  246.    SEE ALSO
  247.  
  248.  
  249. egb/gbscrollbox.library/EGB_SetTopElem egb/gbscrollbox.library/EGB_SetTopElem
  250.  
  251.    NAME
  252.     EGB_SetTopElem -- 
  253.  
  254.    SYNOPSIS
  255.     EGB_SetTopElem(win, gad, elem)
  256.                    A0   A1   A2
  257.  
  258.     void EGB_SetTopElem(EI_WindowPtr, EI_GadgetPtr, struct Node *)
  259.  
  260.    FUNCTION
  261.     Changes the visible area of a scrollbox gadget.
  262.  
  263.    INPUTS
  264.     win     : The window that contains the gadget; if NULL, no refresh is done
  265.     gad     : The scrollbox gadget
  266.     item    : This item will become the topmost one in the visible area of the
  267.         scrollgadget
  268.  
  269.    RESULT
  270.  
  271.    SEE ALSO
  272.  
  273.  
  274. egb/gbscrollbox.library/EGB_UpdateScrollBoxegb/gbscrollbox.library/EGB_UpdateScrollBox
  275.  
  276.    NAME
  277.     EGB_UpdateScrollBox -- 
  278.  
  279.    SYNOPSIS
  280.     EGB_UpdateScrollBox(win, gad)
  281.                         A0   A1
  282.  
  283.     void EGB_UpdateScrollBox(EI_WindowPtr, EI_GadgetPtr)
  284.  
  285.    FUNCTION
  286.     Updates a scrollbox, after its item list has be changed manually.
  287.     You must call this function every time you have changed the item
  288.     list. But don't forget to lock egsintui (EI_LockIntution) while you
  289.     work in the gadgets private data structure. In general it is better
  290.     to remove the list from the scrollbox, work outside and add it again
  291.     afterwards. If you want to avoid that the empty gadget is drawn after
  292.     you removed the items, call EGB_RemListFromScrollBox with win=NULL.
  293.     But make sure that you add the items again after the operation.
  294.  
  295.    INPUTS
  296.     win     : The window that contains the gadget; if NULL, no refresh is done
  297.     gad     : The scrollbox gadget
  298.  
  299.    RESULT
  300.  
  301.    SEE ALSO
  302.  
  303.  
  304.